/*
 * ImplementarAyudaStandar.java
 *
 * Copyright 2011 Universidad Francisco de Paula Santander (UFPS).
 * Todos los Derechos Reservados.
 * Creado el 06/05/11, 10:45:38 PM
 */
package com.ufps.cuatro.util;

import java.util.ArrayList;

/**
 * <i><b>ImplementarAyudaStandar:</b></i>Esta Interfaz implementa un sistema de
 * ayuda que requiere que el contenido se encuentre almacenado en cada archivo 
 * de recursos de la clase a la que se aplique.
 * 
 * @author Carlos A. Torres C. - Dolly E. Guerrero. <https://code.google.com/p/tesis4dor/>
 * @version 1.0 06/05/11
 */
public interface ImplementarAyudaStandar {    
           
    /**
     * Devuelve la Colección de Mensajes de Ayuda Asociados a la Clase.
     * @return Colección de Mensajes de Ayuda Asociados a la Clase.      
     */
    public ArrayList<MensajeAyudaVentana> getMensajesAyuda();
    
    /**
     * Este Método Utilitario se encarga de descomponer los token contenidos
     * en la cadena y crea una Colección con los valores de cada token extraidos
     * del archivo de recursos asociados a la Clase.
     * @param key Llave en archivo de recursos asociado a la Clase.
     * @param tokens Lista de Token a procesar.
     * @return Colección con los valores de cada token extraidos
     * del archivo de recursos asociados a la Clase.
     */
    public ArrayList<String[]> getPropertiesList(String key, String tokens);
    
    /**
     * Devuelve el Contenido del Mensaje en una Colección que representan cada
     * linea de texto.
     * @param objMensaje Encabezado del Mensaje.
     * @return Contenido del Mensaje en una Colección que representan cada
     * linea de texto.
     */
    public ArrayList<MensajeLineaAyudaVentana> getLineaMensajeAyuda(MensajeAyudaVentana objMensaje);
    
}
